package com.zeng.annotation.restmodel;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * restful模型字段配置
 */
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface RestModelField {
    /**
     * 字段别名
     */
    public String name() default "";

    /**
     * 字段类型
     */
    public String type() default "";

    /**
     * 字段注释
     */
    public String comment() default "";

    /**
     * 是否可空（默认可空）
     */
    public boolean nullable() default true;

    /**
     * 是否主键（默认否）
     */
    public boolean primaryKey() default false;

    /**
     * 是否自动递增（默认否）
     */
    public boolean autoIncrement() default false;

    /**
     * 是否是唯一索引 （默认否）
     */
    public boolean unique() default false;

    /**
     * 是否忽略此字段
     */
    public boolean ignore() default false;
}
